

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The baseView module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The qt module" href="mod_pyamp_ui_qt.html" />
    <link rel="next" title="The input module" href="mod_pyamp_ui_input.html" />
    <link rel="prev" title="The scrollableList module" href="pyamp_ui_qt_scrollableList.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_ui_input.html" title="The input module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_scrollableList.html" title="The scrollableList module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui.html" >The ui module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui_qt.html" accesskey="U">The qt module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.ui.qt.baseView">
<span id="the-baseview-module"></span><h1>The baseView module<a class="headerlink" href="#module-pyamp.ui.qt.baseView" title="Permalink to this headline">¶</a></h1>
<p>The baseView module contains the BaseView class which provides a base
framework for more easily creating and using Qt objects.</p>
<div class="section" id="the-baseview-class">
<h2>The BaseView class<a class="headerlink" href="#the-baseview-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-51798269468c74c24c99330103359f2a0d73a43c.png" alt="Inheritance diagram of pyamp.ui.qt.baseView.BaseView" usemap="#inheritance2a1f76ea8e" class="inheritance"/>
<map id="inheritance2a1f76ea8e" name="inheritance2a1f76ea8e">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="#pyamp.ui.qt.baseView.BaseView" title="pyamp.ui.qt.baseView.BaseView" alt="" coords="289,84,513,111"/>
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="464,7,699,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.ui.qt.baseView.BaseView">
<em class="property">class </em><tt class="descclassname">pyamp.ui.qt.baseView.</tt><tt class="descname">BaseView</tt><big>(</big><em>name=None</em>, <em>controller=None</em>, <em>mainWindow=None</em>, <em>logData=None</em>, <em>logColor=0</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView" title="Permalink to this definition">¶</a></dt>
<dd><p>The BaseView class provides a base framework for creating Qt
objects.</p>
<p>It provides several functions that are called in a specific order,
and are to be overridden by subclasses in order to provide a
specific implementation for the BaseView. These functions pertain
to certain aspects of setting up a view and are called in the
following order:</p>
<ol class="arabic simple">
<li>configure()</li>
<li>createLayout()</li>
<li>configureLayout()</li>
<li>setupView()</li>
<li>setupConnections()</li>
</ol>
<p>This class implements the <a class="reference internal" href="../logging.html#pyamp.logging.Loggable" title="pyamp.logging.Loggable"><tt class="xref py py-class docutils literal"><span class="pre">pyamp.logging.Loggable</span></tt></a> interface
and provides the ability to specify the <tt class="xref py py-attr docutils literal"><span class="pre">logData</span></tt> object
as well as the <tt class="xref py py-attr docutils literal"><span class="pre">color</span></tt> to use for logging (the default
color is to use a white foreground color).</p>
<ul class="simple">
<li>name &#8211; The name of the BaseView</li>
<li>controller &#8211; The controller for the BaseView</li>
<li>mainWindow &#8211; The main window</li>
<li>logData &#8211; The LogData object</li>
<li>logColor &#8211; The color to use for the logger</li>
</ul>
<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.completeSetup">
<tt class="descname">completeSetup</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.completeSetup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.completeSetup" title="Permalink to this definition">¶</a></dt>
<dd><p>Finish setting up the view.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.configure">
<tt class="descname">configure</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.configure" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the view.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.configureLayout">
<tt class="descname">configureLayout</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.configureLayout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.configureLayout" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the layout for this view.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.createLayout">
<tt class="descname">createLayout</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.createLayout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.createLayout" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the main layout.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.setController">
<tt class="descname">setController</tt><big>(</big><em>controller</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.setController"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.setController" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the controller object for this view.</p>
<ul class="simple">
<li>controller &#8211; The controller</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.setupConnections">
<tt class="descname">setupConnections</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.setupConnections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.setupConnections" title="Permalink to this definition">¶</a></dt>
<dd><p>Set up any connections this view requires.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.baseView.BaseView.setupView">
<tt class="descname">setupView</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/baseView.html#BaseView.setupView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.baseView.BaseView.setupView" title="Permalink to this definition">¶</a></dt>
<dd><p>Create and set up this view.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by subclasses.</p>
</div>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The baseView module</a><ul>
<li><a class="reference internal" href="#the-baseview-class">The BaseView class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_ui_qt_scrollableList.html"
                        title="previous chapter">The scrollableList module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="mod_pyamp_ui_input.html"
                        title="next chapter">The input module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_ui_qt_baseView.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_ui_input.html" title="The input module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_scrollableList.html" title="The scrollableList module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui.html" >The ui module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui_qt.html" >The qt module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>